home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 10 / AACD 10.iso / AACD / Utilities / PalmLink / developer / palmlink-arexx.doc next >
Text File  |  2000-01-06  |  12KB  |  554 lines
  1. TABLE OF CONTENTS
  2.  
  3. PALM_Accept
  4. PALM_AddSyncLogEntry
  5. PALM_CloseSocket
  6. PALM_EndOfSync
  7. PALM_Explain
  8. PALM_GetBaudRate
  9. PALM_GetDBInfo
  10. PALM_GetStorageInfo
  11. PALM_GetSysInfo
  12. PALM_LastError
  13. PALM_NetSyncInfo
  14. PALM_OpenConduit
  15. PALM_OpenSocket
  16. PALM_ResetLastSyncPC
  17. PALM_ResetSystem
  18. PALM_SysTime
  19. PALM_UserInfo
  20.  
  21. PALM_Accept
  22.  
  23.    NAME
  24.         PALM_Accept -- accept a connection
  25.  
  26.    SYNTAX
  27.         PALM_Accept(socket,<parameters>)
  28.  
  29.    FUNCTION
  30.         Wait for a connection request from Palm Pilot, and accept it. If
  31.         there was no connection until Timeout, a timeout error will be
  32.         returned.
  33.  
  34.         Usually, the connection is started by pressing the HotSync button
  35.         on the cradle.
  36.  
  37.    INPUT
  38.         socket          -- socket name
  39.  
  40.    PARAMETERS
  41.         TIMEOUT/K/N     -- Timeout until this function returns, in seconds.
  42.                 Defaults to 30 seconds.
  43.  
  44.    RESULT
  45.         nothing
  46.  
  47.    NOTE
  48.  
  49.    BUGS
  50.  
  51.    SEE
  52.  
  53. PALM_AddSyncLogEntry
  54.  
  55.    NAME
  56.         PALM_AddSyncLogEntry -- add an entry to the HotSync log
  57.  
  58.    SYNTAX
  59.         PALM_AddSyncLogEntry(socket,<parameters>)
  60.  
  61.    FUNCTION
  62.         Add an entry to the HotSync log. The user can read the last HotSync
  63.         log with the HotSync tool of the Palm Pilot.
  64.  
  65.    INPUT
  66.         socket          -- socket name
  67.  
  68.    PARAMETERS
  69.         ENTRY/A         -- Entry to be added to the HotSync log
  70.         NOLF/S          -- Do not add a line feed to the entry
  71.  
  72.    RESULT
  73.  
  74.    NOTE
  75.  
  76.    BUGS
  77.  
  78.    SEE
  79.  
  80. PALM_CloseSocket
  81.  
  82.    NAME
  83.         PALM_CloseSocket -- close a socket to a Palm Pilot
  84.  
  85.    SYNTAX
  86.         PALM_CloseConduit(socket)
  87.  
  88.    FUNCTION
  89.         Close a socket to a Palm Pilot. Make sure to close all data bases
  90.         before. PalmLink won't do this for you.
  91.  
  92.    INPUT
  93.         socket          -- socket name of the socket to be closed
  94.  
  95.    RESULT
  96.         nothing
  97.  
  98.    NOTE
  99.         Make sure to close the socket even if an ARexx error occured
  100.         and the script is aborted. Otherwise you will not be able to
  101.         connect to this socket again!
  102.  
  103.    BUGS
  104.         Currently, a socket name is global and shared by all ARexx
  105.         scripts running. Please be careful not to produce a clash,
  106.         make sure only one script is running simultaneously.
  107.  
  108.    SEE
  109.         PALM_OpenSocket
  110.  
  111. PALM_EndOfSync
  112.  
  113.    NAME
  114.         PALM_EndOfSync -- terminate all database accesses
  115.  
  116.    SYNTAX
  117.         PALM_EndOfSync(socket,<parameters>)
  118.  
  119.    FUNCTION
  120.         Closes the Pilot database. After you called this function, you
  121.         should close the connection.
  122.  
  123.         *NEVER* forget to call PALM_EndOfSync when you called
  124.         PALM_OpenConduit. PalmLink won't do this for you.
  125.  
  126.    INPUT
  127.         socket          -- socket name
  128.  
  129.    PARAMETERS
  130.         STATUS/N        -- Status code, optional.
  131.  
  132.    RESULT
  133.         nothing
  134.  
  135.    NOTE
  136.  
  137.    BUGS
  138.  
  139.    SEE
  140.  
  141. PALM_Explain
  142.  
  143.    NAME
  144.         PALM_Explain -- explain an error code
  145.  
  146.    SYNTAX
  147.         PALM_Explain(socket,<parameters>)
  148.  
  149.    FUNCTION
  150.         Explains the provided error code.
  151.  
  152.         If the error was a DOS error code, it will be explained as
  153.         well, using dos.library.
  154.  
  155.    INPUT
  156.         socket          -- socket name
  157.  
  158.    PARAMETERS
  159.         CODE/A          -- error code to be explained
  160.  
  161.    RESULT
  162.         Explained error code
  163.  
  164.    NOTE
  165.  
  166.    BUGS
  167.  
  168.    SEE
  169.  
  170. PALM_GetBaudRate
  171.  
  172.    NAME
  173.         PALM_GetBaudRate -- get negotiated baud rate
  174.  
  175.    SYNTAX
  176.         PALM_GetBaudRate(socket)
  177.  
  178.    FUNCTION
  179.         The currently negotiated baud rate with the Palm is
  180.         returned. Only valid after PALM_Accept has returned.
  181.  
  182.    INPUT
  183.         socket          -- socket name
  184.  
  185.    RESULT
  186.         Negotiated baud rate.
  187.  
  188.    NOTE
  189.  
  190.    BUGS
  191.  
  192.    SEE
  193.  
  194. PALM_GetDBInfo
  195.  
  196.    NAME
  197.         PALM_GetDBInfo -- get information about the database
  198.  
  199.    SYNTAX
  200.         PALM_GetDBInfo(socket,<parameters>,stem)
  201.  
  202.    FUNCTION
  203.         The passed stem variable is filled with information
  204.         about the database with the number provided in INDEX.
  205.  
  206.    INPUT
  207.         socket          -- socket name
  208.         stem            -- name of the stem variable to be filled
  209.  
  210.    PARAMETERS
  211.         INDEX/N/A       -- Index of the database entry to be read.
  212.                 Start with 0, then traverse with STEM.INDEX+1.
  213.         ROM/S           -- If passed, all ROM databases are read
  214.                 instead of the RAM databases
  215.         CARD/K/N        -- Select the card to be read. Defaults to
  216.                 card 0.
  217.  
  218.    STEM
  219.         NAME            -- Name of the entry
  220.         INDEX           -- Index of this entry
  221.         CREATED         -- Creation date (YYYY-MM-DD HH:MM:SS)
  222.         MODIFIED        -- Modification date (YYYY-MM-DD HH:MM:SS)
  223.         BACKUPPED       -- Backup date (YYYY-MM-DD HH:MM:SS, or ---)
  224.         VERSION         -- Version number
  225.         CREATOR         -- Creator ID
  226.         TYPE            -- Type ID
  227.         FLAGS           -- Flags (as decimal, see include file)
  228.         EXCLUDE         -- Exclude flags (as decimal, see include file)
  229.  
  230.    RESULT
  231.         0 if there are no further entries, else any other number
  232.  
  233.    NOTE
  234.  
  235.    BUGS
  236.  
  237.    SEE
  238.  
  239. PALM_GetStorageInfo
  240.  
  241.    NAME
  242.         PALM_GetStorageInfo -- get information about a card
  243.  
  244.    SYNTAX
  245.         PALM_GetStorageInfo(socket,<parameters>,stem)
  246.  
  247.    FUNCTION
  248.         The passed stem variable is filled with information
  249.         about the card with the number provided in CARD.
  250.  
  251.    INPUT
  252.         socket          -- socket name
  253.         stem            -- name of the stem variable to be filled
  254.  
  255.    PARAMETERS
  256.         CARD/N          -- Select the card to be read. Defaults to
  257.                 card 0.
  258.  
  259.    STEM
  260.         NAME            -- Name of the card
  261.         MANUFACTURER    -- Card manufacturer
  262.         CARDNO          -- Number of the current card. Iterate with
  263.                 CARD=CARDNO+1
  264.         VERSION         -- Version
  265.         CREATED         -- Creation time (YYYY-MM-DD HH:MM:SS)
  266.         ROMSIZE         -- Size of permanent memory
  267.         RAMSIZE         -- Size of volatile memory
  268.         RAMFREE         -- Size of free RAM space
  269.  
  270.    RESULT
  271.         0 if there are no further entries, else any other number
  272.  
  273.    NOTE
  274.  
  275.    BUGS
  276.  
  277.    SEE
  278.  
  279. PALM_GetSysInfo
  280.  
  281.    NAME
  282.         PALM_GetSysInfo -- get information about the system
  283.  
  284.    SYNTAX
  285.         PALM_GetSysInfo(socket,stem)
  286.  
  287.    FUNCTION
  288.         The passed stem variable is filled with information
  289.         about the system.
  290.  
  291.    INPUT
  292.         socket          -- socket name
  293.         stem            -- name of the stem variable to be filled
  294.  
  295.    STEM
  296.         SYSNAME         -- Name of the system
  297.         ROMVERSION      -- Version of the OS
  298.         LOCALIZION      -- Localizion code
  299.  
  300.    RESULT
  301.  
  302.    NOTE
  303.  
  304.    BUGS
  305.  
  306.    SEE
  307.  
  308. PALM_LastError
  309.  
  310.    NAME
  311.         PALM_LastError -- return the last error code
  312.  
  313.    SYNTAX
  314.         PALM_LastError(socket)
  315.  
  316.    FUNCTION
  317.         Return the code of the last error. Negative codes are PalmLink
  318.         errors. Positive are DLP error codes.
  319.  
  320.    INPUT
  321.         socket          -- socket name
  322.  
  323.    RESULT
  324.         error code
  325.  
  326.    NOTE
  327.  
  328.    BUGS
  329.  
  330.    SEE
  331.  
  332. PALM_NetSyncInfo
  333.  
  334.    NAME
  335.         PALM_NetSyncInfo -- get/set information about netsync
  336.  
  337.    SYNTAX
  338.         PALM_NetSyncInfo(socket,<parameters>,stem)
  339.  
  340.    FUNCTION
  341.         The passed stem variable is filled with information
  342.         about the netsync. Optionally, some fields can be changed
  343.         first, using the parameters.
  344.  
  345.    INPUT
  346.         socket          -- socket name
  347.         stem            -- name of the stem variable to be filled
  348.  
  349.    PARAMETERS
  350.         LANSYNC/K/N     -- Lansync code (?)
  351.         HOSTNAME/K      -- Host name
  352.         HOSTADDRESS/K   -- Host address
  353.         HOSTSUBNETMASK/K -- Host subnet mask
  354.  
  355.    STEM
  356.         LANSYNC         -- Lansync code (?)
  357.         HOSTNAME        -- Host name
  358.         HOSTADDRESS     -- Host address
  359.         HOSTSUBNETMASK  -- Host subnet mask
  360.  
  361.    RESULT
  362.  
  363.    NOTE
  364.  
  365.    BUGS
  366.  
  367.    SEE
  368.  
  369. PALM_OpenConduit
  370.  
  371.    NAME
  372.         PALM_OpenConduit -- Initialize database access
  373.  
  374.    SYNTAX
  375.         PALM_OpenConduit(socket)
  376.  
  377.    FUNCTION
  378.         Open the Pilot database for access. You must call this function
  379.         after a successful PALM_Accept.
  380.  
  381.    INPUT
  382.         socket          -- socket name
  383.  
  384.    RESULT
  385.         nothing
  386.  
  387.    NOTE
  388.  
  389.    BUGS
  390.  
  391.    SEE
  392.  
  393. PALM_OpenSocket
  394.  
  395.    NAME
  396.         PALM_OpenSocket -- open a socket to a Palm Pilot
  397.  
  398.    SYNTAX
  399.         PALM_OpenSocket(socket,<parameters>)
  400.  
  401.    FUNCTION
  402.         Open a new socket to a Palm Pilot. The Pilot must be connected to
  403.         a serial port. As default, the internal serial port is used.
  404.  
  405.    INPUT
  406.         socket          -- socket name of the socket to be opened
  407.  
  408.    PARAMETERS
  409.         SD=DEVICE/K     -- serial device the pilot is connected to
  410.         SU=UNIT/K/N     -- serial unit
  411.         SB=MAXBAUD/K/N  -- maximum baud rate supported by the device
  412.  
  413.    RESULT
  414.         nothing
  415.  
  416.    NOTE
  417.  
  418.    BUGS
  419.         Currently, a socket name is global and shared by all ARexx
  420.         scripts running. Please be careful not to produce a clash,
  421.         make sure only one script is running simultaneously.
  422.  
  423.    SEE
  424.         PALM_CloseSocket
  425.  
  426. PALM_ResetLastSyncPC
  427.  
  428.    NAME
  429.         PALM_ResetLastSyncPC -- clear LastSyncPC
  430.  
  431.    SYNTAX
  432.         PALM_ResetLastSyncPC(socket)
  433.  
  434.    FUNCTION
  435.         Reset the LastSyncPC field in the UserInfo.
  436.  
  437.    INPUT
  438.         socket          -- socket name
  439.  
  440.    RESULT
  441.         nothing
  442.  
  443.    NOTE
  444.  
  445.    BUGS
  446.  
  447.    SEE
  448.  
  449. PALM_ResetSystem
  450.  
  451.    NAME
  452.         PALM_ResetSystem -- reset the Palm Pilot
  453.  
  454.    SYNTAX
  455.         PALM_ResetSystem(socket)
  456.  
  457.    FUNCTION
  458.         Reset the Palm Pilot when the connection is closed.
  459.  
  460.    INPUT
  461.         socket          -- socket name
  462.  
  463.    RESULT
  464.         nothing
  465.  
  466.    NOTE
  467.  
  468.    BUGS
  469.  
  470.    SEE
  471.  
  472. PALM_SysTime
  473.  
  474.    NAME
  475.         PALM_SysTime -- get/set system time
  476.  
  477.    SYNTAX
  478.         PALM_SysTime(socket,<parameters>,stem)
  479.  
  480.    FUNCTION
  481.         The passed stem variable is filled with information
  482.         about the system time. Optionally, some fields can be changed
  483.         first, using the parameters.
  484.  
  485.    INPUT
  486.         socket          -- socket name
  487.         stem            -- name of the stem variable to be filled
  488.  
  489.    PARAMETERS
  490.         D=DAY/K/N       -- Change the day
  491.         MO=MONTH/K/N    -- Change the month (1..12)
  492.         Y=YEAR/K/N      -- Change the year (please use 4 digits!)
  493.         H=HOUR/K/N      -- Change the hour
  494.         MI=MINUTE/K/N   -- Change the minute
  495.         S=SECOND/K/N    -- Change the second
  496.  
  497.    STEM
  498.         TIME            -- Current time (YYYY-MM-DD HH:MM:SS)
  499.         SECOND          -- Current second
  500.         MINUTE          -- Current minute
  501.         HOUR            -- Current hour
  502.         DAY             -- Current Day
  503.         MONTH           -- Current Month (1..12)
  504.         YEAR            -- Current Year (4 digits)
  505.  
  506.    RESULT
  507.  
  508.    NOTE
  509.  
  510.    BUGS
  511.  
  512.    SEE
  513.  
  514. PALM_UserInfo
  515.  
  516.    NAME
  517.         PALM_UserInfo -- get/set information about the user
  518.  
  519.    SYNTAX
  520.         PALM_UserInfo(socket,<parameters>,stem)
  521.  
  522.    FUNCTION
  523.         The passed stem variable is filled with information
  524.         about the user. Optionally, some fields can be changed
  525.         first, using the parameters.
  526.  
  527.    INPUT
  528.         socket          -- socket name
  529.         stem            -- name of the stem variable to be filled
  530.  
  531.    PARAMETERS
  532.         USERNAME/K      -- Set a new user name
  533.         PASSWORD/K      -- Set a new password (Encrypted)
  534.  
  535.    STEM
  536.         USERID          -- User ID
  537.         VIEWERID        -- Viewer ID
  538.         LASTSYNCPC      -- LastSyncPC code
  539.         LASTSYNC        -- Time of last sync attempt (YYYY-MM-DD HH:MM:SS)
  540.         SUCCESSFULSYNC  -- Time of last successful sync (YYYY-MM-DD HH:MM:SS)
  541.         USERNAME        -- User name
  542.         PASSWORD        -- Password (Encrypted)
  543.  
  544.    RESULT
  545.  
  546.    NOTE
  547.  
  548.    BUGS
  549.  
  550.    SEE
  551.         PALM_ResetLastSyncPC
  552.  
  553.  
  554.